home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d20 / 2dapnt15.arc / 2DAPOINT.DOC < prev    next >
Text File  |  1991-11-26  |  11KB  |  288 lines
  1. 2DaPoint                                                                Page 1
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                       ╓─╖  ╥─┐  ╓─┐  ╥─┐  ╓─┐  ╥  ╥─┐  ─┬─
  8.                       ╓─╜  ║ │  ╟─┤  ╟─┘  ║ │  ║  ║ │   │
  9.                       ╙──  ╨─┘  ╜ └  ╨    ╙─┘  ╨  ╨ ┴   ┴
  10.                         The *Complete* Netmail Processor
  11.                      Version 1.50 Reference Guide  11/1991
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.            A totally free mail bundler for use on FTSC compliant .MSG
  21.                  files with the BinkleyTerm 2.50 FidoNet Mailer
  22.  
  23.  
  24.             Software & documentation by Ron Pritchett of 1:376/74.0
  25.  
  26.  
  27.  
  28.                     Copyright (c) 1991 Realm Software
  29.                            All Rights Reserved
  30.  
  31.  
  32.  
  33.                             Realm Software
  34.                            133 WaterView Dr
  35.                           Columbia, SC 29212
  36.  
  37.  
  38.  
  39.  
  40. 2DaPoint                                                                Page 2
  41.  
  42. INTRODUCTION
  43.  
  44.    This software was written on a whim. After noticing how well Maximus
  45.  CBCS handles point addressing, I started searching for an equally
  46.  point-aware NetMail Bundler. The idea is that the average caller/user
  47.  shouldn't have to know anything about the pseudo point network/secondary
  48.  set of addresses. The only thing I found that came close was REMAPPER by
  49.  Bob Hartman (of ConfMail fame), but this didn't work quite the way I
  50.  wanted it to & lacked a few features. Finally I downloaded a copy of the
  51.  FTSC specs & went to work on my own program. Here it is.
  52.  
  53.  
  54.   >>What it does<<
  55.  
  56.   - Full zone support.
  57.  
  58.   - Complete Message bundling (.?UT file generator) for normally addressed
  59.     messages including File Requests, File Attaches, Forwarding, Crash,
  60.     Hold, & Kill. Also processes any Echomail that has happened to have
  61.     landed in your netmail dir. (ie the whole 9 yards)
  62.  
  63.   - Through File Attaches between points or BBSes which can optionally be
  64.     deleted once sent. Multiple File Attaches & File Requests are supported
  65.     too.
  66.  
  67.   - Recognition of point addresses embedded within messages to send the
  68.     message to the proper host or point host.
  69.  
  70.   - Address redirection (including points) via name recognition.
  71.  
  72.   - Name remapping via alias name recognition.
  73.  
  74.   >>What it doesn't do<<
  75.  
  76.   - It won't do XRobot-type automatic mailings/file attaches.
  77.  
  78.   - It won't balance your checkbook.
  79.  
  80.   - It won't fix your recently pedestrian-damaged Buick Impala for free or
  81.     even at a discount rate.
  82.  
  83. CONTROL FILE
  84.  
  85.   2DaPoint requires the presence of a control file called 2DAPOINT.CTL
  86. which must reside in the same directory the executable program is. There
  87. is no way/reason to have the control file named anything else.
  88.  
  89.   A sample configuration file with internal documentation is included. The
  90. sample is actually MY control file. It's short & sweet. Not too many options
  91. or things to go wrong. 2DaPoint is very forgiving about the information
  92. contained in the control file. If information is missing or invalid, the
  93. program will point out which additional information is needed/invalid.
  94.  
  95. 2DaPoint                                                                Page 3
  96.  
  97. The commands are listed here in alphabetical order for reference ease.
  98.  
  99.   Address <(zone:)net/node(.point)>
  100.  
  101.           Here your full address must be specified. Zone & point are not
  102.           a required portion of the address; zone 1 is assumed & .0 is
  103.           also assumed. The point portion of the address is recognized,
  104.           but is only for future expansion. It may possible to run this
  105.           program from a point system, but I haven't tried it.
  106.  
  107.   FileFwd <Kill | Save>
  108.  
  109.           This options controls whether or not a file passing thru
  110.           your node is to be killed or saved. If 'Kill' is specified,
  111.           then file will be killed by your mailer after it has been sent.
  112.           If 'Save' is specified, the file will not be killed, it'll just
  113.           sit in your inbound directory. NOTE: This only applies to
  114.           passthru files (ie they didn't originate from your node & they're
  115.           not destine to your node).
  116.  
  117.   Forward <Kill | Save>
  118.  
  119.           This options controls whether or not a message passing thru
  120.           your node is to be killed or saved. If 'Kill' is specified,
  121.           then message will be packed up & then the .MSG file will
  122.           be erased. If 'Save' is specified, the message will not be killed
  123.           just marked as 'Sent'.
  124.  
  125.   Inbound <directory>
  126.  
  127.           This is the path of your incoming file/mail directory. This is
  128.           used for passthru file attaches for your node. This way points
  129.           can send mail amongst themselves via your host or even to other
  130.           nodes or other points on other nodes.
  131.  
  132.           For Example, when a point sends a file to another point, the
  133.           subject line of the message contains the path & filename of the
  134.           file to be sent. Well, there's only a one in a million chance that
  135.           this will be the same on the both the point's & Host's computer.
  136.           2DaPoint will replace the path on the incoming message with the
  137.           directory name that you have specified. (ie where the file is now
  138.           located on the host system.)
  139.  
  140.   Log <filename>
  141.  
  142.           This filename, which can include drive & path specifications,
  143.           is where 2DaPoint logs it's activities. Versions prior to 1.50
  144.           were forced to use the file: 2DAPOINT.LOG in the directory where
  145.           the program was being run.
  146.  
  147.   Mail <directory>
  148.  
  149.           This is the path to your netmail messages directory. 2DaPoint
  150.           looks here for messages that need to be sent, etc.
  151.  
  152. 2DaPoint                                                                Page 4
  153.  
  154.   Mode <Net | Node>
  155.  
  156.           This option controls whether a message bound for a point is
  157.           to be saved in a .PNT directory (for pickup or mailing) or
  158.           it's to be sent to the point's host system. If operating in
  159.           'Net' mode, any mail bound for a point in your zone & network
  160.           will be packed up for it's full 4D address & placed in a .PNT
  161.           subdirectory in your outbound mail area.
  162.           (If you're unfamiliar with the new .PNT directory format, refer
  163.           to the Binkley 2.50 documentation or the example in 2DaPoint.ctl.)
  164.  
  165.           If operating in 'Node' mode, the additional constraint of a point
  166.           being your point is added. If a message is received for your
  167.           point, then (as above) it is bundled into a .PNT directory.
  168.           Otherwise, the message is sent to that point's host. Once there
  169.           the ^ATOPT would be recognized & the message would be sent along
  170.           the proper path.
  171.  
  172.   Names
  173.           This marks the beginning of your name service addressing. One
  174.           name & address appear per line until the keyword END is
  175.           encoutered. If a message is bound for a node in your Network
  176.           or your PointNet and the name is in the control file, then the
  177.           destination in the control file is used instead of the one
  178.           embedded in the message. (Read that sentence again, I'm sure
  179.           it'll be the source of some confusion. <grin> )
  180.  
  181.           The syntax of the NAMES block is:
  182.  
  183.           Names
  184.             ( <alias1> ^) <name 1>  <address | Hold>
  185.             ( <alias2> ^) <name 2>  <address | Hold>
  186.             ........  .........
  187.             ( <aliasx> ^) <name x>  <address | Hold>
  188.           End
  189.  
  190.           Where <name> can be any numbers of words (theoretically). And
  191.           <address> is a full or partial address. "What's a partial
  192.           address?" you're asking. Well basically it means that the part
  193.           of the address that you don't explicitly enter, will be assumed
  194.           based upon what address you have specified for your address via
  195.           the ADDRESS statement. See examples in control file.
  196.  
  197.           If an <alias> is present, then any message addressed to
  198.           <alias> or <name> will be sent to <name> @ <address>. The ^
  199.           character delimites between the <alias> & <name>. See example
  200.           control file for examples that might wipe away your confusion. <g>
  201.  
  202.           Also: the <address> may be "Hold" which will simply hold the
  203.           message and not send it anywhere.
  204.  
  205. 2DaPoint                                                                Page 5
  206.  
  207.   Notify <None | OurNet | All>
  208.  
  209.           If someone sends a message to your system & it is mis-addressed
  210.           (according to the name service table) then the sender of the
  211.           message will get a notice saying that they haven't sent their
  212.           msg to the wrong address & also listed will be the correct
  213.           address.
  214.  
  215.           None   - will disable this feature.
  216.           OurNet - will only send to nodes/point in your network.
  217.           All    - will send a FYI msg back to the sender no matter what
  218.                    net or zone they're in.
  219.  
  220.   Outbound <directory>
  221.  
  222.           This is the path to your outbound mail directory. All generated
  223.           outbound bundles/packets will be placed in this directory.
  224.  
  225.   PWFile <filename>
  226.  
  227.           This filename, which can include drive & path specifications,
  228.           is where 2DaPoint reads passwords for use in secure enviroments.
  229.           In a secure enviroment, packet headers have paswords embedded in
  230.           them. The password command syntax in the PWFile is:
  231.  
  232.           Password   Address  Password_for_That_Node
  233.  
  234.           Example:
  235.           Password   1:376/74.51  BLAHBLAH
  236.  
  237.   SetBit   <bitmask>
  238.   StripBit <bitmask>
  239.  
  240.           Once it's been determined that the message needs to be sent, The
  241.           bits defined here will either be turned on or off in the status
  242.           of the message. This doesn't apply to echomail destine for other
  243.           systems that has happened to land in you netmail directory.
  244.           See Control file for detailed info.
  245.  
  246.   ZoneGate <On | Off>
  247.  
  248.           Use zone gating. See Control file for detailed info.
  249.  
  250. 2DaPoint                                                                Page 6
  251.  
  252. COMMAND LINE PARAMETERS
  253.  
  254.  -B  = Use BIOS calls instead of direct video writes.
  255.  
  256.  
  257. EXIT ERRORLEVELS
  258.  
  259.  Exit ErrorLevel Codes
  260.    0 - No Mail Processed
  261.    1 - control file missing
  262.    2 - Incorrect Control file parameter(s)
  263.    3 - Netmail, Inbound, or Outbound dir doesn't exist
  264.    4 - Outbound Mail Created
  265.  
  266.  
  267. LEGAL STUFF
  268.  
  269.   I take no reponsibility for what this program will do. It is NOT a trojan
  270. horse type program, but who knows what could happen with an incompetent user.
  271.  
  272.  
  273. CLOSING THOUGHTS
  274.  
  275.   This program has been thoroughly tested with Maximus & should work on Fido,
  276. Opus & any other FTSC-compliant BBSwares. Please report any problems
  277. encountered, if any. The latest version can be F'req-ed from 1:376/74 with
  278. the magic filename of 2DAPOINT.
  279.  
  280.   That's it! I'm not much on docs. I'd love to hear from you. If you thought
  281. this software is trash, helpful, lacking in a few areas, whatever!
  282.  
  283.  
  284.  
  285.  
  286.                                                   Ron Pritchett
  287.                                                   1:376/74.0
  288.